Inside Macintosh: QuickDraw GX Graphics /

Chapter 2 - Geometric Shapes / Geometric Shapes Reference

Functions / Getting and Setting Shape Geometries

GXSetRectangle

You can use the GXSetRectangle function to change the geometry of a rectangle shape.

void GXSetRectangle(gxShape target, const gxRectangle *data);

target

A reference to the rectangle shape whose geometry you want to change.

data

A pointer to the new rectangle geometry.

DESCRIPTION

The GXSetRectangle function copies the geometry information from the data parameter into the geometry property of the target shape. If the target shape is not a rectangle shape, this function replaces the target shape with a rectangle shape and sets the shape fill to closed-frame fill if it was originally open-frame fill.

If the target shape is not a rectangle shape, this function posts the error code illegal_type_for_shape.

You must provide a pointer to a gxRectangle structure in the data parameter--if you pass nil for this parameter, the function posts the error code parameter_is_nil.

If the target shape is locked (that is, its gxLockedShape shape attribute is set), this function posts the error shape_access_not_allowed.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil
parameter_is_nil	(debugging version)
shape_access_not_allowed	(debugging version)

SEE ALSO

For general information about rectangle geometries, see "Rectangle Shapes" on page 2-20.

For the definition of the gxRectangle structure, see page 2-106.

To create a new rectangle shape, use the GXNewRectangle function, which is described on page 2-114.

To examine the geometry of an existing rectangle shape, use the GXGetRectangle function, which is described on page 2-127.

To draw a rectangle geometry without creating a rectangle shape, use the GXDrawRectangle function, which is described on page 2-160. To draw a rectangle shape, use the GXDrawShape function, which is described in the chapter "Shape Objects" in Inside Macintosh: QuickDraw GX Objects.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help